home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / cmds / gdb-4.5 / dist / bfd / targets.c < prev    next >
Encoding:
C/C++ Source or Header  |  1992-07-21  |  15.5 KB  |  534 lines
  1. /* Generic target-file-type support for the BFD library.
  2.    Copyright (C) 1990-1991 Free Software Foundation, Inc.
  3.    Written by Cygnus Support.
  4.  
  5. This file is part of BFD, the Binary File Descriptor library.
  6.  
  7. This program is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 2 of the License, or
  10. (at your option) any later version.
  11.  
  12. This program is distributed in the hope that it will be useful,
  13. but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15. GNU General Public License for more details.
  16.  
  17. You should have received a copy of the GNU General Public License
  18. along with this program; if not, write to the Free Software
  19. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
  20.  
  21. /* $Id: targets.c,v 1.55 1992/02/22 05:46:50 gnu Exp $ */
  22.  
  23. #include "bfd.h"
  24. #include "sysdep.h"
  25. #include "libbfd.h"
  26.  
  27. /*
  28. SECTION 
  29.     Targets
  30.  
  31. DESCRIPTION
  32.     Each port of BFD to a different machine requries the creation
  33.     of a target back end. All the back end provides to the root
  34.     part of BFD is a structure containing pointers to functions
  35.     which perform certain low level operations on files. BFD
  36.     translates the applications's requests through a pointer into
  37.     calls to the back end routines. 
  38.  
  39.     When a file is opened with <<bfd_openr>>, its format and
  40.     target are unknown. BFD uses various mechanisms to determine
  41.     how to interpret the file. The operations performed are:
  42.  
  43.     o First a BFD is created by calling the internal routine
  44.     <<new_bfd>>, then <<bfd_find_target>> is called with the
  45.     target string supplied to <<bfd_openr>> and the new BFD pointer. 
  46.  
  47.     o If a null target string was provided to <<bfd_find_target>>,
  48.     it looks up the environment variable <<GNUTARGET>> and uses
  49.     that as the target string. 
  50.  
  51.     o If the target string is still NULL, or the target string is
  52.     <<default>>, then the first item in the target vector is used
  53.     as the target type. @xref{bfd_target}.
  54.  
  55.     o Otherwise, the elements in the target vector are inspected
  56.     one by one, until a match on target name is found. When found,
  57.     that is used. 
  58.  
  59.     o Otherwise the error <<invalid_target>> is returned to
  60.     <<bfd_openr>>.
  61.  
  62.     o <<bfd_openr>> attempts to open the file using
  63.     <<bfd_open_file>>, and returns the BFD.
  64.  
  65.     Once the BFD has been opened and the target selected, the file
  66.     format may be determined. This is done by calling
  67.     <<bfd_check_format>> on the BFD with a suggested format. The
  68.     routine returns <<true>> when the application guesses right.
  69. @menu
  70. @* bfd_target::
  71. @end menu
  72. */
  73.  
  74.  
  75. /*
  76.  
  77. INODE
  78.     bfd_target,  , Targets, Targets
  79.  
  80. SUBSECTION
  81.     bfd_target
  82.  
  83. DESCRIPTION
  84.     This structure contains everything that BFD knows about a
  85.     target. It includes things like its byte order, name, what
  86.     routines to call to do various operations, etc.   
  87.  
  88.     Every BFD points to a target structure with its <<xvec>>
  89.     member. 
  90.  
  91.     Shortcut for declaring fields which are prototyped function
  92.     pointers, while avoiding anguish on compilers that don't
  93.     support protos.
  94.  
  95. .#define SDEF(ret, name, arglist) \
  96. .                PROTO(ret,(*name),arglist)
  97. .#define SDEF_FMT(ret, name, arglist) \
  98. .                PROTO(ret,(*name[bfd_type_end]),arglist)
  99.  
  100.     These macros are used to dispatch to functions through the
  101.     bfd_target vector. They are used in a number of macros further
  102.     down in @file{bfd.h}, and are also used when calling various
  103.     routines by hand inside the BFD implementation.  The "arglist"
  104.     argument must be parenthesized; it contains all the arguments
  105.     to the called function. 
  106.  
  107.  
  108. .#define BFD_SEND(bfd, message, arglist) \
  109. .               ((*((bfd)->xvec->message)) arglist)
  110.  
  111.     For operations which index on the BFD format 
  112.  
  113. .#define BFD_SEND_FMT(bfd, message, arglist) \
  114. .            (((bfd)->xvec->message[(int)((bfd)->format)]) arglist)
  115.  
  116.     This is the struct which defines the type of BFD this is.  The
  117.     <<xvec>> member of the struct <<bfd>> itself points here.  Each
  118.     module that implements access to a different target under BFD,
  119.     defines one of these.
  120.  
  121.  
  122.     FIXME, these names should be rationalised with the names of
  123.     the entry points which call them. Too bad we can't have one
  124.     macro to define them both! 
  125.  
  126. .typedef struct bfd_target
  127. .{
  128.  
  129. identifies the kind of target, eg SunOS4, Ultrix, etc 
  130.  
  131. .  char *name;
  132.  
  133. The "flavour" of a back end is a general indication about the contents
  134. of a file.
  135.  
  136. .  enum target_flavour {
  137. .    bfd_target_unknown_flavour,
  138. .    bfd_target_aout_flavour,
  139. .    bfd_target_coff_flavour,
  140. .    bfd_target_elf_flavour,
  141. .    bfd_target_ieee_flavour,
  142. .    bfd_target_oasys_flavour,
  143. .    bfd_target_srec_flavour} flavour;
  144.  
  145. The order of bytes within the data area of a file.
  146.  
  147. .  boolean byteorder_big_p;
  148.  
  149. The order of bytes within the header parts of a file.
  150.  
  151. .  boolean header_byteorder_big_p;
  152.  
  153. This is a mask of all the flags which an executable may have set -
  154. from the set <<NO_FLAGS>>, <<HAS_RELOC>>, ...<<D_PAGED>>.
  155.  
  156. .  flagword object_flags;       
  157.  
  158. This is a mask of all the flags which a section may have set - from
  159. the set <<SEC_NO_FLAGS>>, <<SEC_ALLOC>>, ...<<SET_NEVER_LOAD>>.
  160.  
  161. .  flagword section_flags;
  162.  
  163. The pad character for filenames within an archive header.
  164.  
  165. .  char ar_pad_char;            
  166.  
  167. The maximum number of characters in an archive header.
  168.  
  169. . unsigned short ar_max_namelen;
  170.  
  171. The minimum alignment restriction for any section.
  172.  
  173. .  unsigned int align_power_min;
  174.  
  175. Entries for byte swapping for data. These are different to the other
  176. entry points, since they don't take BFD as first arg.  Certain other handlers
  177. could do the same.
  178.  
  179. .  SDEF (bfd_vma,      bfd_getx64, (bfd_byte *));
  180. .  SDEF (void,         bfd_putx64, (bfd_vma, bfd_byte *));
  181. .  SDEF (bfd_vma, bfd_getx32, (bfd_byte *));
  182. .  SDEF (void,         bfd_putx32, (bfd_vma, bfd_byte *));
  183. .  SDEF (bfd_vma, bfd_getx16, (bfd_byte *));
  184. .  SDEF (void,         bfd_putx16, (bfd_vma, bfd_byte *));
  185.  
  186. Byte swapping for the headers
  187.  
  188. .  SDEF (bfd_vma,   bfd_h_getx64, (bfd_byte *));
  189. .  SDEF (void,          bfd_h_putx64, (bfd_vma, bfd_byte *));
  190. .  SDEF (bfd_vma,  bfd_h_getx32, (bfd_byte *));
  191. .  SDEF (void,          bfd_h_putx32, (bfd_vma, bfd_byte *));
  192. .  SDEF (bfd_vma,  bfd_h_getx16, (bfd_byte *));
  193. .  SDEF (void,          bfd_h_putx16, (bfd_vma, bfd_byte *));
  194.  
  195. Format dependent routines, these turn into vectors of entry points
  196. within the target vector structure; one for each format to check.
  197.  
  198. Check the format of a file being read.  Return bfd_target * or zero. 
  199.  
  200. .  SDEF_FMT (struct bfd_target *, _bfd_check_format, (bfd *));
  201.  
  202. Set the format of a file being written.  
  203.  
  204. .  SDEF_FMT (boolean,            _bfd_set_format, (bfd *));
  205.  
  206. Write cached information into a file being written, at bfd_close. 
  207.  
  208. .  SDEF_FMT (boolean,            _bfd_write_contents, (bfd *));
  209.  
  210. The following functions are defined in <<JUMP_TABLE>>. The idea is
  211. that the back end writer of <<foo>> names all the routines
  212. <<foo_>>@var{entry_point}, <<JUMP_TABLE>> will built the entries
  213. in this structure in the right order.
  214.  
  215. Core file entry points
  216.  
  217. .  SDEF (char *, _core_file_failing_command, (bfd *));
  218. .  SDEF (int,    _core_file_failing_signal, (bfd *));
  219. .  SDEF (boolean, _core_file_matches_executable_p, (bfd *, bfd *));
  220.  
  221. Archive entry points
  222.  
  223. . SDEF (boolean, _bfd_slurp_armap, (bfd *));
  224. . SDEF (boolean, _bfd_slurp_extended_name_table, (bfd *));
  225. . SDEF (void,   _bfd_truncate_arname, (bfd *, CONST char *, char *));
  226. . SDEF (boolean, write_armap, (bfd *arch, 
  227. .                              unsigned int elength,
  228. .                              struct orl *map,
  229. .                              unsigned int orl_count, 
  230. .                              int stridx));
  231.  
  232. Standard stuff.
  233.  
  234. .  SDEF (boolean, _close_and_cleanup, (bfd *));
  235. .  SDEF (boolean, _bfd_set_section_contents, (bfd *, sec_ptr, PTR,
  236. .                                            file_ptr, bfd_size_type));
  237. .  SDEF (boolean, _bfd_get_section_contents, (bfd *, sec_ptr, PTR, 
  238. .                                            file_ptr, bfd_size_type));
  239. .  SDEF (boolean, _new_section_hook, (bfd *, sec_ptr));
  240.  
  241. Symbols and reloctions
  242.  
  243. .  SDEF (unsigned int, _get_symtab_upper_bound, (bfd *));
  244. .  SDEF (unsigned int, _bfd_canonicalize_symtab,
  245. .           (bfd *, struct symbol_cache_entry **));
  246. .  SDEF (unsigned int, _get_reloc_upper_bound, (bfd *, sec_ptr));
  247. .  SDEF (unsigned int, _bfd_canonicalize_reloc, (bfd *, sec_ptr, arelent **,
  248. .                                               struct symbol_cache_entry**));
  249. .  SDEF (struct symbol_cache_entry  *, _bfd_make_empty_symbol, (bfd *));
  250. .  SDEF (void,     _bfd_print_symbol, (bfd *, PTR, struct symbol_cache_entry  *,
  251. .                                      bfd_print_symbol_type));
  252. .#define bfd_print_symbol(b,p,s,e) BFD_SEND(b, _bfd_print_symbol, (b,p,s,e))
  253. .  SDEF (alent *,   _get_lineno, (bfd *, struct symbol_cache_entry  *));
  254. .
  255. .  SDEF (boolean,   _bfd_set_arch_mach, (bfd *, enum bfd_architecture,
  256. .                                       unsigned long));
  257. .
  258. .  SDEF (bfd *,  openr_next_archived_file, (bfd *arch, bfd *prev));
  259. .  SDEF (boolean, _bfd_find_nearest_line,
  260. .        (bfd *abfd, struct sec  *section,
  261. .         struct symbol_cache_entry  **symbols,bfd_vma offset,
  262. .        CONST char **file, CONST char **func, unsigned int *line));
  263. .  SDEF (int,    _bfd_stat_arch_elt, (bfd *, struct stat *));
  264. .
  265. .  SDEF (int,    _bfd_sizeof_headers, (bfd *, boolean));
  266. .
  267. .  SDEF (void, _bfd_debug_info_start, (bfd *));
  268. .  SDEF (void, _bfd_debug_info_end, (bfd *));
  269. .  SDEF (void, _bfd_debug_info_accumulate, (bfd *, struct sec  *));
  270. .  SDEF (bfd_byte *, _bfd_get_relocated_section_contents, (bfd*,struct bfd_seclet_struct *));
  271. .  SDEF (boolean,_bfd_relax_section,(bfd *, struct sec *, struct symbol_cache_entry **));
  272. Special entry points for gdb to swap in coff symbol table parts
  273.  
  274. .  SDEF(void, _bfd_coff_swap_aux_in,(
  275. .       bfd            *abfd ,
  276. .       PTR             ext,
  277. .       int             type,
  278. .       int             class ,
  279. .       PTR             in));
  280. .
  281. .  SDEF(void, _bfd_coff_swap_sym_in,(
  282. .       bfd            *abfd ,
  283. .       PTR             ext,
  284. .       PTR             in));
  285. .
  286. .  SDEF(void, _bfd_coff_swap_lineno_in,  (
  287. .       bfd            *abfd,
  288. .       PTR            ext,
  289. .       PTR             in));
  290. .
  291.  
  292. Special entry points for gas to swap coff parts
  293.  
  294. . SDEF(unsigned int, _bfd_coff_swap_aux_out,(
  295. .       bfd       *abfd,
  296. .       PTR    in,
  297. .       int        type,
  298. .       int        class,
  299. .       PTR        ext));
  300. .
  301. . SDEF(unsigned int, _bfd_coff_swap_sym_out,(
  302. .      bfd      *abfd,
  303. .      PTR    in,
  304. .      PTR    ext));
  305. .
  306. . SDEF(unsigned int, _bfd_coff_swap_lineno_out,(
  307. .          bfd       *abfd,
  308. .          PTR    in,
  309. .    PTR    ext));
  310. .
  311. . SDEF(unsigned int, _bfd_coff_swap_reloc_out,(
  312. .          bfd     *abfd,
  313. .         PTR    src,
  314. .    PTR    dst));
  315. .
  316. . SDEF(unsigned int, _bfd_coff_swap_filehdr_out,(
  317. .          bfd      *abfd,
  318. .    PTR     in,
  319. .    PTR     out));
  320. .
  321. . SDEF(unsigned int, _bfd_coff_swap_aouthdr_out,(
  322. .          bfd     *abfd,
  323. .    PTR     in,
  324. .    PTR    out));
  325. .
  326. . SDEF(unsigned int, _bfd_coff_swap_scnhdr_out,(
  327. .          bfd      *abfd,
  328. .          PTR    in,
  329. .    PTR    out));
  330. .
  331. .} bfd_target;
  332.  
  333. */
  334.  
  335. /* The default is to define a target_vector containing all the targets.
  336.    By setting MINIMIZE=1 on the "make" command line, the user can change this
  337.    to a vector containing just DEFAULT_VECTOR and any required
  338.    traditional-core-file handler.  (This is to save space in the executables.)
  339.    The config files can also override the default large vector by giving an
  340.    explicit SELECT_VECS macro.  */
  341.  
  342. #if MINIMIZE && defined(DEFAULT_VECTOR) && !defined(SELECT_VECS)
  343. #ifdef TRAD_CORE
  344. #define SELECT_VECS &DEFAULT_VECTOR,&trad_core_vec
  345. #else
  346. #define SELECT_VECS &DEFAULT_VECTOR
  347. #endif
  348. #endif
  349.  
  350. #if MINIMIZE && defined(DEFAULT_VECTOR) && !defined(SELECT_VECS) && defined(VM_CORE)
  351. #define SELECT_VECS &DEFAULT_VECTOR,&vm_core_vec
  352. #endif
  353.  
  354. /* All known xvecs.  They are listed a second time below, since
  355.    we can't intermix extern's and initializers.  */
  356. extern bfd_target ecoff_little_vec;
  357. extern bfd_target ecoff_big_vec;
  358. extern bfd_target sunos_big_vec;
  359. extern bfd_target demo_64_vec;
  360. extern bfd_target srec_vec;
  361. extern bfd_target b_out_vec_little_host;
  362. extern bfd_target b_out_vec_big_host;
  363. extern bfd_target icoff_little_vec;
  364. extern bfd_target icoff_big_vec;
  365. extern bfd_target elf_little_vec;
  366. extern bfd_target elf_big_vec;
  367. extern bfd_target ieee_vec;
  368. extern bfd_target oasys_vec;
  369. extern bfd_target m88kbcs_vec;
  370. extern bfd_target m68kcoff_vec;
  371. extern bfd_target i386coff_vec;
  372. extern bfd_target i386aout_vec;
  373. extern bfd_target a29kcoff_big_vec;
  374. extern bfd_target trad_core_vec;
  375. extern bfd_target vm_core_vec;
  376. extern bfd_target rs6000coff_vec;
  377. extern bfd_target h8300coff_vec;
  378.  
  379. #ifdef DEFAULT_VECTOR
  380. extern bfd_target DEFAULT_VECTOR;
  381. #endif
  382.  
  383. #ifdef SELECT_VECS
  384.  
  385. bfd_target *target_vector[] = {
  386.     SELECT_VECS,
  387.     0
  388. };
  389.  
  390. #else
  391.  
  392. bfd_target *target_vector[] = {
  393.  
  394. #ifdef DEFAULT_VECTOR
  395.     &DEFAULT_VECTOR,
  396. #endif
  397.  
  398.     &i386coff_vec,
  399.     &i386aout_vec,
  400.     &ecoff_little_vec,
  401.     &ecoff_big_vec,
  402.     &ieee_vec,
  403. #if 0
  404.     /* We have no oasys tools anymore, so we can't test any of this
  405.        anymore. If you want to test the stuff yourself, go ahead...
  406.        steve@cygnus.com */
  407.     &oasys_vec,
  408. #endif
  409.     &sunos_big_vec,
  410. #ifdef HOST_64_BIT
  411.     &demo_64_vec,    /* Only compiled if host has long-long support */
  412. #endif
  413.     &h8300coff_vec,
  414.     &m88kbcs_vec,
  415.     &srec_vec,
  416.     &icoff_little_vec,
  417.     &icoff_big_vec,
  418.     &elf_little_vec,
  419.     &elf_big_vec,
  420.     &b_out_vec_little_host,
  421.     &b_out_vec_big_host,
  422.     &m68kcoff_vec,
  423.     &a29kcoff_big_vec,
  424.     &rs6000coff_vec,
  425.  
  426. #ifdef    TRAD_CORE
  427.     &trad_core_vec,
  428. #endif
  429. #ifdef  VM_CORE
  430.     &vm_core_vec,
  431. #endif
  432.     NULL, /* end of list marker */
  433. };
  434.  
  435. #endif
  436.  
  437. /* default_vector[0] contains either the address of the default vector,
  438.    if there is one, or zero if there isn't.  */
  439.  
  440. bfd_target *default_vector[] = {
  441. #ifdef DEFAULT_VECTOR
  442.     &DEFAULT_VECTOR,
  443. #endif
  444.     0,
  445. };
  446.  
  447.  
  448.  
  449.  
  450. /*
  451. FUNCTION
  452.     bfd_find_target
  453.  
  454. DESCRIPTION
  455.     Returns a pointer to the transfer vector for the object target
  456.     named target_name.  If target_name is NULL, chooses the one in
  457.     the environment variable GNUTARGET; if that is null or not
  458.     defined thenthe first entry in the target list is chosen.
  459.     Passing in the string "default" or setting the environment
  460.     variable to "default" will cause the first entry in the target
  461.     list to be returned, and "target_defaulted" will be set in the
  462.     BFD.  This causes <<bfd_check_format>> to loop over all the
  463.     targets to find the one that matches the file being read.   
  464.  
  465. SYNOPSIS
  466.     bfd_target *bfd_find_target(CONST char *, bfd *);
  467. */
  468.  
  469. bfd_target *
  470. DEFUN(bfd_find_target,(target_name, abfd),
  471.       CONST char *target_name AND
  472.       bfd *abfd)
  473. {
  474.   bfd_target **target;
  475.   extern char *getenv ();
  476.   CONST char *targname = (target_name ? target_name : 
  477.               (CONST char *) getenv ("GNUTARGET"));
  478.  
  479.   /* This is safe; the vector cannot be null */
  480.   if (targname == NULL || !strcmp (targname, "default")) {
  481.     abfd->target_defaulted = true;
  482.     return abfd->xvec = target_vector[0];
  483.   }
  484.  
  485.   abfd->target_defaulted = false;
  486.  
  487.   for (target = &target_vector[0]; *target != NULL; target++) {
  488.     if (!strcmp (targname, (*target)->name))
  489.       return abfd->xvec = *target;
  490.   }
  491.  
  492.   bfd_error = invalid_target;
  493.   return NULL;
  494. }
  495.  
  496.  
  497. /*
  498. FUNCTION
  499.     bfd_target_list
  500.  
  501. DESCRIPTION
  502.     This function returns a freshly malloced NULL-terminated
  503.     vector of the names of all the valid BFD targets. Do not
  504.     modify the names 
  505.  
  506. SYNOPSIS
  507.     CONST char **bfd_target_list(void);
  508.  
  509. */
  510.  
  511. CONST char **
  512. DEFUN_VOID(bfd_target_list)
  513. {
  514.   int vec_length= 0;
  515.   bfd_target **target;
  516.   CONST  char **name_list, **name_ptr;
  517.  
  518.   for (target = &target_vector[0]; *target != NULL; target++)
  519.     vec_length++;
  520.  
  521.   name_ptr = 
  522.     name_list = (CONST char **) zalloc ((vec_length + 1) * sizeof (char **));
  523.  
  524.   if (name_list == NULL) {
  525.     bfd_error = no_memory;
  526.     return NULL;
  527.   }
  528.  
  529.   for (target = &target_vector[0]; *target != NULL; target++)
  530.     *(name_ptr++) = (*target)->name;
  531.  
  532.   return name_list;
  533. }
  534.